/*
 * Copyright 2010-2020 Alfresco Software, Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.activiti.engine.impl.asyncexecutor;

import org.activiti.engine.api.internal.Internal;
import org.activiti.engine.impl.cfg.ProcessEngineConfigurationImpl;
import org.activiti.engine.impl.persistence.entity.JobEntity;
import org.activiti.engine.runtime.Job;

/**
 *
 */
@Internal
public interface AsyncExecutor {

  /**
   * Starts the Async Executor: jobs will be acquired and executed.
   */
  void start();

  /**
   * Stops executing jobs.
   */
  void shutdown();

  /**
   * Offers the provided {@link JobEntity} to this {@link AsyncExecutor} instance
   * to execute. If the offering does not work for some reason, false
   * will be returned (For example when the job queue is full in the {@link DefaultAsyncJobExecutor}).
   */
  boolean executeAsyncJob(Job job);


  /* Getters and Setters */

  void setProcessEngineConfiguration(ProcessEngineConfigurationImpl processEngineConfiguration);

  ProcessEngineConfigurationImpl getProcessEngineConfiguration();

  boolean isAutoActivate();

  void setAutoActivate(boolean isAutoActivate);

  boolean isActive();

  String getLockOwner();

  int getTimerLockTimeInMillis();

  void setTimerLockTimeInMillis(int lockTimeInMillis);

  int getAsyncJobLockTimeInMillis();

  void setAsyncJobLockTimeInMillis(int lockTimeInMillis);

  int getDefaultTimerJobAcquireWaitTimeInMillis();

  void setDefaultTimerJobAcquireWaitTimeInMillis(int waitTimeInMillis);

  int getDefaultAsyncJobAcquireWaitTimeInMillis();

  void setDefaultAsyncJobAcquireWaitTimeInMillis(int waitTimeInMillis);

  public int getDefaultQueueSizeFullWaitTimeInMillis();

  public void setDefaultQueueSizeFullWaitTimeInMillis(int defaultQueueSizeFullWaitTimeInMillis);

  int getMaxAsyncJobsDuePerAcquisition();

  void setMaxAsyncJobsDuePerAcquisition(int maxJobs);

  int getMaxTimerJobsPerAcquisition();

  void setMaxTimerJobsPerAcquisition(int maxJobs);

  int getRetryWaitTimeInMillis();

  void setRetryWaitTimeInMillis(int retryWaitTimeInMillis);

  int getResetExpiredJobsInterval();

  void setResetExpiredJobsInterval(int resetExpiredJobsInterval);

  int getResetExpiredJobsPageSize();

  void setResetExpiredJobsPageSize(int resetExpiredJobsPageSize);

}
